
<!DOCTYPE HTML>
<html lang="" >
    <head>
        <meta charset="UTF-8">
        <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
        <title>Read Me · MassTransit</title>
        <meta http-equiv="X-UA-Compatible" content="IE=edge" />
        <meta name="description" content="">
        <meta name="generator" content="GitBook 3.2.2">
        
        
        
    
    <link rel="stylesheet" href="MassTransit/gitbook/style.css">

    
            
                
                <link rel="stylesheet" href="MassTransit/gitbook/gitbook-plugin-prism/prism.css">
                
            
                
                <link rel="stylesheet" href="MassTransit/gitbook/gitbook-plugin-search/search.css">
                
            
                
                <link rel="stylesheet" href="MassTransit/gitbook/gitbook-plugin-fontsettings/website.css">
                
            
        

    

    
        
        <link rel="stylesheet" href="MassTransit/build/gitbook.css">
        
    
        
    
        
    
        
    
        
    
        
    

        
    
    
    <meta name="HandheldFriendly" content="true"/>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <meta name="apple-mobile-web-app-capable" content="yes">
    <meta name="apple-mobile-web-app-status-bar-style" content="black">
    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="MassTransit/gitbook/images/apple-touch-icon-precomposed-152.png">
    <link rel="shortcut icon" href="MassTransit/gitbook/images/favicon.ico" type="image/x-icon">

    
    <link rel="next" href="MassTransit/introduction.md" />
    
    
    <link rel="prev" href="MassTransit/" />
    

    </head>
    <body>
        
<div class="book">
    <div class="book-summary">
        
            
<div id="book-search-input" role="search">
    <input type="text" placeholder="Type to search" />
</div>

            
                <nav role="navigation">
                


<ul class="summary">
    
    

    

    
        
        
    
        <li class="chapter " data-level="1.1" data-path="MassTransit/">
            
                <a href="MassTransit/">
            
                    
                    Introduction
            
                </a>
            

            
        </li>
    
        <li class="chapter active" data-level="1.2" data-path="./">
            
                <a href="./">
            
                    
                    Read Me
            
                </a>
            

            
        </li>
    

    
        
        <li class="header">Overview</li>
        
        
    
        <li class="chapter " data-level="2.1" data-path="MassTransit/introduction.md">
            
                <span>
            
                    
                    Introduction
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="2.2" data-path="MassTransit/loving-the-community.html">
            
                <a href="MassTransit/loving-the-community.html">
            
                    
                    Loving the Community
            
                </a>
            

            
        </li>
    

    
        
        <li class="header">Usage</li>
        
        
    
        <li class="chapter " data-level="3.1" data-path="MassTransit/installation.html">
            
                <a href="MassTransit/installation.html">
            
                    
                    Installation
            
                </a>
            

            
            <ul class="articles">
                
    
        <li class="chapter " data-level="3.1.1" data-path="MassTransit/prerequisites.html">
            
                <a href="MassTransit/prerequisites.html">
            
                    
                    Prerequisites
            
                </a>
            

            
        </li>
    
        <li class="chapter " data-level="3.1.2" data-path="MassTransit/how-to-install.html">
            
                <a href="MassTransit/how-to-install.html">
            
                    
                    How to Install
            
                </a>
            

            
        </li>
    

            </ul>
            
        </li>
    
        <li class="chapter " data-level="3.2" data-path="MassTransit/using-masstransit.html">
            
                <a href="MassTransit/using-masstransit.html">
            
                    
                    Using MassTransit
            
                </a>
            

            
            <ul class="articles">
                
    
        <li class="chapter " data-level="3.2.1" data-path="MassTransit/message-contracts.html">
            
                <a href="MassTransit/message-contracts.html">
            
                    
                    Message Contracts
            
                </a>
            

            
        </li>
    

            </ul>
            
        </li>
    

    

    <li class="divider"></li>

    <li>
        <a href="https://www.gitbook.com" target="blank" class="gitbook-link">
            Published with GitBook
        </a>
    </li>
</ul>


                </nav>
            
        
    </div>

    <div class="book-body">
        
            <div class="body-inner">
                
                    

<div class="book-header" role="navigation">
    

    <!-- Title -->
    <h1>
        <i class="fa fa-circle-o-notch fa-spin"></i>
        <a href="MassTransit" >Read Me</a>
    </h1>
</div>




                    <div class="page-wrapper" tabindex="-1" role="main">
                        <div class="page-inner">
                            
<div id="book-search-results">
    <div class="search-noresults">
    
                                <section class="normal markdown-section">
                                
                                <h1 id="masstransit">MassTransit</h1>
<p>MassTransit is a <em>free, open-source</em> distributed application framework for .NET. MassTransit makes it easy to create applications and services that leverage message-based, loosely-coupled asynchronous communication for higher availability, reliabililty, and scalability.</p>
<p><img src="https://raw.githubusercontent.com/MassTransit/MassTransit/develop/doc/source/mt-logo.png" alt="Mass Transit" title="Mass Transit"></p>
<p>MassTransit is Apache 2.0 licensed.</p>
<p><img src="https://ci.appveyor.com/api/projects/status/hox8dhh5eyy7jsf4/branch/master?svg=true" alt="master">
<img src="https://ci.appveyor.com/api/projects/status/hox8dhh5eyy7jsf4/branch/develop?svg=true" alt="develop"></p>
<h2 id="getting-started-with-masstransit">Getting started with MassTransit</h2>
<p>In order to get started with MassTransit, you can have a look at the documentation, which is located at <a href="http://docs.masstransit-project.com/" target="_blank">http://docs.masstransit-project.com/</a>.</p>
<h3 id="simplest-possible-thing">Simplest possible thing:</h3>
<p><code>install-package MassTransit.RabbitMq</code> then;</p>
<pre class="language-"><code>// Message Definition
class MyMessage
{
    public string Value { get; set; }
}

// Code Snippet for Console Application 
var bus = Bus.Factory.CreateUsingRabbitMq(sbc =&gt;
{
    var host = sbc.Host(new Uri(&quot;rabbitmq://localhost/&quot;), h =&gt;
    {
        h.Username(&quot;guest&quot;);
        h.Password(&quot;guest&quot;);
    });

    sbc.ReceiveEndpoint(host, &quot;my_queue&quot;, endpoint =&gt;
    {
        endpoint.Handler<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span>MyMessage</span><span class="token punctuation">&gt;</span></span>(async context =&gt;
        {
            await Console.Out.WriteLineAsync($&quot;Received: {context.Message.Value}&quot;);
        });
    });
});

using(bus.Start())
{
    bus.Publish(new MyMessage{Value = &quot;Hello, World.&quot;});

    Console.ReadLine();
}
</code></pre><p>You will also need to set up RabbitMQ; </p>
<ol>
<li><strong>Install Erlang</strong> using the <a href="http://www.erlang.org/download.html" target="_blank">installer</a>. (Next -&gt; Next ...)</li>
<li><strong>Install RabbitMQ</strong> using the <a href="http://www.rabbitmq.com/download.html" target="_blank">installer</a>. (Next -&gt; Next ...) You now have a RabbitMQ broker (look in <code>services.msc</code> for it) that you can <a href="http://localhost:15672/#/" target="_blank">log into</a> using <code>guest</code>, <code>guest</code>. You can see message rates, routings and active consumers using this interface. </li>
</ol>
<p><strong>Please note</strong> </p>
<p>You need to add the management interface before you can login. First, from an elevated command prompt, change directory to the sbin folder within the RabbitMQ Server installation directory e.g. <code>%PROGRAMFILES%\RabbitMQ Server\rabbitmq_server_3.5.3\sbin\</code></p>
<p>Next, run the following command to enable the rabbitmq management plugin:</p>
<pre class="language-"><code>rabbitmq-plugins.bat enable rabbitmq_management 
</code></pre><h3 id="downloads">Downloads</h3>
<p>Download from NuGet &apos;MassTransit&apos; <a href="http://nuget.org/packages?q=masstransit" target="_blank">Search NuGet for MassTransit</a></p>
<p>Download the continuously integrated Nuget packages from <a href="https://ci.appveyor.com/project/phatboyg/masstransit/build/artifacts" target="_blank">AppVeyor</a>.</p>
<h3 id="supported-transports">Supported transports</h3>
<p>We support RabbitMQ and Azure Service Bus message brokers.</p>
<h2 id="mailing-list">Mailing list</h2>
<p><a href="http://groups.google.com/group/masstransit-discuss" target="_blank">MassTransit Discuss</a></p>
<h2 id="gitter-chat">Gitter Chat</h2>
<p>While attendence is pretty light, there is a Gitter chat room available:</p>
<p><a href="https://gitter.im/MassTransit/MassTransit?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge" target="_blank"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Join the chat at https://gitter.im/MassTransit/MassTransit"></a></p>
<h2 id="building-from-source">Building from Source</h2>
<ol>
<li>Clone the source down to your machine. 
<code>git clone git://github.com/MassTransit/MassTransit.git</code></li>
<li>Run <code>build.bat</code></li>
</ol>
<h2 id="contributing">Contributing</h2>
<ol>
<li><code>git config --global core.autocrlf false</code></li>
<li>Hack!</li>
<li>Make a pull request.</li>
</ol>
<h2 id="builds">Builds</h2>
<p>MassTransit is built on <a href="https://ci.appveyor.com/project/phatboyg/masstransit" target="_blank">AppVeyor</a></p>
<h1 id="requirements">REQUIREMENTS</h1>
<ul>
<li>.Net 4.5.2</li>
</ul>
<h1 id="credits">CREDITS</h1>
<p>Logo Design by <a href="http://www.theagilebadger.com" target="_blank">The Agile Badger</a></p>

                                
                                </section>
                            
    </div>
    <div class="search-results">
        <div class="has-results">
            
            <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
            <ul class="search-results-list"></ul>
            
        </div>
        <div class="no-results">
            
            <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
            
        </div>
    </div>
</div>

                        </div>
                    </div>
                
            </div>

            
                
                <a href="MassTransit/" class="navigation navigation-prev " aria-label="Previous page: Introduction">
                    <i class="fa fa-angle-left"></i>
                </a>
                
                
                <a href="MassTransit/introduction.md" class="navigation navigation-next " aria-label="Next page: Introduction">
                    <i class="fa fa-angle-right"></i>
                </a>
                
            
        
    </div>

    <script>
        var gitbook = gitbook || [];
        gitbook.push(function() {
            gitbook.page.hasChanged({"page":{"title":"Read Me","level":"1.2","depth":1,"next":{"title":"Introduction","level":"2.1","depth":1,"path":"introduction.md","ref":"introduction.md","articles":[]},"previous":{"title":"Introduction","level":"1.1","depth":1,"path":"README.md","ref":"README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["edit-link","prism","-highlight","github","anchorjs","livereload"],"root":"docs","styles":{"website":"build/gitbook.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/MassTransit/MassTransit/"},"livereload":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"edit-link":{"label":"Edit This Page","base":"https://github.com/masstransit/masstransit/tree/master"},"theme-default":{"styles":{"website":"build/gitbook.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false},"anchorjs":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"MassTransit","gitbook":"3.2.2"},"file":{"path":"../README.md","mtime":"2016-12-10T20:35:42.000Z","type":"markdown"},"gitbook":{"version":"3.2.2","time":"2017-01-11T20:32:16.573Z"},"basePath":"MassTransit","book":{"language":""}});
        });
    </script>
</div>

        
    <script src="MassTransit/gitbook/gitbook.js"></script>
    <script src="MassTransit/gitbook/theme.js"></script>
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-edit-link/plugin.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-github/plugin.js"></script>
        
    
        
        <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/3.1.1/anchor.min.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-anchorjs/anchor-style.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-livereload/plugin.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-search/search-engine.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-search/search.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-sharing/buttons.js"></script>
        
    
        
        <script src="MassTransit/gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
        
    

    </body>
</html>

